Guidelines for creating good Short Descriptions

Rule forms and data instance forms contain a Short Description field, also known as its label. Internally, the field corresponds to the @baseclass.pyLabel property.

Take a few moments to choose the text you enter in this field as you save each rule. Your choice can enhance your personal productivity, the productivity of your development team, and affect the usability of your application.

While most Short Description text is less than 30 characters long, enter more than 30 characters when necessary. (The limit is 64 characters.)

Short Descriptions in user prompts

Short Description text is often visible to application users. Choose text meaningful to such users:

• Flow action rules — Text appears as a selection in lists on user forms, or as button labels. See More about flow actions.
• Classes — The text of a Class form that corresponds to a class group appears as a work pool name on the Work Pool Selector in the Case Manager portal Dashboard. See work pool name, work pool, and More about Classes.
  
  The text of a Class form that corresponds to a case type appears in the Create menu on the Case Manager header.
  
• For Single Value properties, the text appears in certain Report Viewer and Report Wizard lists.

Note: If a standard flow action, flow, or class rule meets your application needs except for its Short Description text, you can override only the Short Description with the Localized Label field in a field value rule.

Note: Changes you make to the Short Description text of a checked-out rule may become visible only after you check in the rule.

Short Descriptions in documentation

Enter a sentence or phrase that describes how you expect the rule to be used. You need not enter your name, the ruleset, any key part, or the date, as this information is present (and searchable) elsewhere in the rule.

The value you enter appears on reports, lists, and SmartPrompt ToolTips. Choose a value that helps you or others select a rule of interest from a possibly long list.

Application Short Description

The Short Description text of an application rule appears in many places throughout Designer Studio. These include the current application on the Application menu, in the Switch Application menu list, in the application filter list on Application landing pages, and on the Application Overview landing page header. You should provide a unique, meaningful name and also include a version number if users have access to multiple versions using the same description.

Short Descriptions that support search

Choose Short Description text that support searches. Longer, specific words (such as Mortgage) are more useful when searching than common short words.

Short Descriptions: Lookup Cache supports SmartPrompt ToolTip display

Short Description text appears as a ToolTip on SmartPrompt displays, when the developer holds a pointer on a row of the selection list. (SmartPrompt displays are primarily accessed by developers, not by application users.) After updating the Short Description, the ToolTip might display a previous value. See Deleting the on-disk cache

Related information

Open topic with navigation